/*
 * Copyright 2011 Mark Davidson.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package org.dctmcommons;

import com.documentum.fc.client.IDfACL;
import com.documentum.fc.client.IDfSession;
import com.documentum.fc.common.DfException;

/**
 * Contains security-related helper methods.
 */
public interface ISecurityHelper {

	/**
	 * Checks whether folder security is enabled.
	 * @param session The session
	 * @return The outcome (true = yes, folder security is enabled)
	 * @throws DfException
	 */
	public boolean isFolderSecurityEnabled(IDfSession session)
			throws DfException;

	/**
	 * Gets an ACL by name.
	 * @param session The repository session
	 * @param aclName The ACL name
	 * @return The ACL
	 * @throws DfException The repository exception
	 */
	public IDfACL getAclByName(IDfSession session,
							   String aclName) throws DfException;
	
	/**
	 * Gets an ACL by qualification.
	 * @param session The repository session
	 * @param qualification The qualification
	 * @return The ACL
	 * @throws DfException The repository exception
	 */
	public IDfACL getAclByQualification(IDfSession session,
										String qualification)
		throws DfException;}